Redfish: Filter empty account slots from ListUsers #6772

mraineri · 2023-06-23T16:11:12Z

SUMMARY

Fixes the output for the ListUsers command in redfish.info to suppress empty account slots for services that do not support POST/DELETE to add/remove users.

Fixex #6771

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

redfish_info.py, redfish_utils.py

ADDITIONAL INFORMATION

Sample playbook; requires a Redfish service that shows empty account slots (like an iDRAC on a Dell PowerEdge server)

---
- hosts: all
  gather_facts: false
  vars:
    username: <REDACTED>
    password: <REDACTED>
    baseuri: <REDACTED>
    default_uri_timeout: 5
    default_uri_retries: 5
  tasks:
  - name: Get users
    community.general.redfish_info:
      category: Accounts
      command: ListUsers
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"
    retries: "{{ default_uri_retries }}"
    register: redfish_results
  - debug:
      var: redfish_results

Before:

ok: [localhost] => {
    "redfish_results": {
        "ansible_facts": {
            "discovered_interpreter_python": "/usr/bin/python3"
        },
        "changed": false,
        "failed": false,
        "redfish_facts": {
            "user": {
                "entries": [
                    {
                        "Enabled": false,
                        "Id": "1",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "None",
                        "UserName": ""
                    },
                    {
                        "Enabled": true,
                        "Id": "2",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "Administrator",
                        "UserName": "root"
                    },
                    {
                        "Enabled": false,
                        "Id": "3",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "4",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "5",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "6",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "7",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "8",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "9",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "10",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "11",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "12",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": true,
                        "Id": "13",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "14",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "15",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    },
                    {
                        "Enabled": false,
                        "Id": "16",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "ReadOnly",
                        "UserName": ""
                    }
                ],
                "ret": true
            }
        }
    }
}

After:

ok: [localhost] => {
    "redfish_results": {
        "ansible_facts": {
            "discovered_interpreter_python": "/usr/bin/python3"
        },
        "changed": false,
        "failed": false,
        "redfish_facts": {
            "user": {
                "entries": [
                    {
                        "Enabled": true,
                        "Id": "2",
                        "Locked": false,
                        "Name": "User Account",
                        "RoleId": "Administrator",
                        "UserName": "root"
                    }
                ],
                "ret": true
            }
        }
    }
}

Signed-off-by: Mike Raineri <michael.raineri@dell.com>

ansibullbot · 2023-06-23T16:13:58Z

cc @Bhavya06 @jyundt @rajeevkallur @renxulei @tomasg2012 @xmadsen
click here for bot help

changelogs/fragments/6771-redfish-filter-empty-account-slots.yml

Co-authored-by: Felix Fontein <felix@fontein.de>

patchback · 2023-06-26T21:29:55Z

Backport to stable-6: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-6/93f5a48b8c155ae91cacd44e80a11b7260dfda24/pr-6772

Backported as #6793

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

* Redfish: Filter empty account slots from ListUsers Signed-off-by: Mike Raineri <michael.raineri@dell.com> * Update 6771-redfish-filter-empty-account-slots.yml * Update changelogs/fragments/6771-redfish-filter-empty-account-slots.yml Co-authored-by: Felix Fontein <felix@fontein.de> --------- Signed-off-by: Mike Raineri <michael.raineri@dell.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 93f5a48)

patchback · 2023-06-26T21:30:04Z

Backport to stable-7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-7/93f5a48b8c155ae91cacd44e80a11b7260dfda24/pr-6772

Backported as #6794

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

felixfontein · 2023-06-26T21:30:07Z

@mraineri thanks for your contribution!

* Redfish: Filter empty account slots from ListUsers Signed-off-by: Mike Raineri <michael.raineri@dell.com> * Update 6771-redfish-filter-empty-account-slots.yml * Update changelogs/fragments/6771-redfish-filter-empty-account-slots.yml Co-authored-by: Felix Fontein <felix@fontein.de> --------- Signed-off-by: Mike Raineri <michael.raineri@dell.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 93f5a48)

…slots from ListUsers (#6793) Redfish: Filter empty account slots from ListUsers (#6772) * Redfish: Filter empty account slots from ListUsers Signed-off-by: Mike Raineri <michael.raineri@dell.com> * Update 6771-redfish-filter-empty-account-slots.yml * Update changelogs/fragments/6771-redfish-filter-empty-account-slots.yml Co-authored-by: Felix Fontein <felix@fontein.de> --------- Signed-off-by: Mike Raineri <michael.raineri@dell.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 93f5a48) Co-authored-by: Mike Raineri <mraineri@gmail.com>

…slots from ListUsers (#6794) Redfish: Filter empty account slots from ListUsers (#6772) * Redfish: Filter empty account slots from ListUsers Signed-off-by: Mike Raineri <michael.raineri@dell.com> * Update 6771-redfish-filter-empty-account-slots.yml * Update changelogs/fragments/6771-redfish-filter-empty-account-slots.yml Co-authored-by: Felix Fontein <felix@fontein.de> --------- Signed-off-by: Mike Raineri <michael.raineri@dell.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 93f5a48) Co-authored-by: Mike Raineri <mraineri@gmail.com>

mraineri and others added 2 commits June 23, 2023 12:08

Redfish: Filter empty account slots from ListUsers

8b88de0

Signed-off-by: Mike Raineri <michael.raineri@dell.com>

Update 6771-redfish-filter-empty-account-slots.yml

e0a663e

ansibullbot added bug This issue/PR relates to a bug module_utils module_utils plugins plugin (any type) labels Jun 23, 2023

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-6 labels Jun 24, 2023

felixfontein reviewed Jun 24, 2023

View reviewed changes

changelogs/fragments/6771-redfish-filter-empty-account-slots.yml Outdated Show resolved Hide resolved

Update changelogs/fragments/6771-redfish-filter-empty-account-slots.yml

b5bb2db

Co-authored-by: Felix Fontein <felix@fontein.de>

felixfontein merged commit 93f5a48 into ansible-collections:main Jun 26, 2023

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Jun 26, 2023

patchback bot mentioned this pull request Jun 26, 2023

[PR #6772/93f5a48b backport][stable-6] Redfish: Filter empty account slots from ListUsers #6793

Merged

patchback bot mentioned this pull request Jun 26, 2023

[PR #6772/93f5a48b backport][stable-7] Redfish: Filter empty account slots from ListUsers #6794

Merged

mraineri deleted the Redfish-Empty-Account-Slots-Fix branch May 17, 2024 18:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Redfish: Filter empty account slots from ListUsers #6772

Redfish: Filter empty account slots from ListUsers #6772

mraineri commented Jun 23, 2023

ansibullbot commented Jun 23, 2023

patchback bot commented Jun 26, 2023 •

edited

Loading

patchback bot commented Jun 26, 2023 •

edited

Loading

felixfontein commented Jun 26, 2023

Redfish: Filter empty account slots from ListUsers #6772

Redfish: Filter empty account slots from ListUsers #6772

Conversation

mraineri commented Jun 23, 2023

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented Jun 23, 2023

patchback bot commented Jun 26, 2023 • edited Loading

Backport to stable-6: 💚 backport PR created

patchback bot commented Jun 26, 2023 • edited Loading

Backport to stable-7: 💚 backport PR created

felixfontein commented Jun 26, 2023

patchback bot commented Jun 26, 2023 •

edited

Loading

patchback bot commented Jun 26, 2023 •

edited

Loading